Update developing locally README #695
Conversation
valentinewallace
left a comment
valentinewallace
left a comment
There was a problem hiding this comment.
LGTM 💯 One nit, but not blocking.
README.md
Outdated
| ### Developing Locally | ||
|
|
||
| You'll need to build `lnd` and `btcd` locally using the [installation guide](http://dev.lightning.community/guides/installation/). Then start by cloning this git repo and go inside the project folder to run the following commands: | ||
| You'll need to build `lnd` and `btcd` locally using the [installation guide](http://dev.lightning.community/guides/installation/). In addition, LND needs to be built with experimental flag enabled: `make && make install tags=experimental`. |
There was a problem hiding this comment.
Nit: our chosen convention is to use lnd instead of LND, so
In addition, LND needs to be built ...
becomes
In addition,
lndneeds to be built ...
|
@valentinewallace updated :) |
valentinewallace
left a comment
valentinewallace
left a comment
There was a problem hiding this comment.
Perfect! Thanks :)
README.md
Outdated
| ### Developing Locally | ||
|
|
||
| You'll need to build `lnd` and `btcd` locally using the [installation guide](http://dev.lightning.community/guides/installation/). Then start by cloning this git repo and go inside the project folder to run the following commands: | ||
| You'll need to build `lnd` and `btcd` locally using the [installation guide](http://dev.lightning.community/guides/installation/). In addition, lnd needs to be built with experimental flag enabled: `make && make install tags=experimental`. |
There was a problem hiding this comment.
Might as well add the whole commands to the docs here:
# install lnd
git clone https://github.com/lightningnetwork/lnd $GOPATH/src/github.com/lightningnetwork/lnd
cd $GOPATH/src/github.com/lightningnetwork/lnd
make && make install tags=experimental
# install btcd
git clone https://github.com/btcsuite/btcd $GOPATH/src/github.com/btcsuite/btcd
cd $GOPATH/src/github.com/btcsuite/btcd
glide install
go install . ./cmd/...
There was a problem hiding this comment.
I'm not sure about adding the full steps to install here since it will additional overhead in regards to keeping documentation up to date. I assume installing with tags=experimental is temporary? I'd rather link to the official lnd and btcd install guide here, respectively.
That being said, I updated the README as requested.
ghost
deleted the
2 participants
Closes: #694